<!doctype html>
<html>
<head>
    <title>API for class CALENDAR (Events Calendar v1.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link href="../style.css" type="text/css" rel="stylesheet" />
</head>
<body>
    <div class="page">
        <div class="header center">
            <div class="content">
                Events Calendar v1.0                <div class="logo_desc">Application Programming Interface</div>
            </div>
        </div>
        <div class="panel">
            <div class="content">
                <h1>Namespaces</h1>
<ul>
    <li><a href="../calendar/package-summary.html">Calendar</a></li>
    <li><a href="../no package/package-summary.html">No Package</a></li>
    <li><a href="../template/package-summary.html">Template</a></li>
</ul>
<h1>Namespace Template</h1>
    <h2>Classes</h2>
    <ul>
            <li><a href="../calendar/calendar.html" title="Calendar \ CALENDAR">CALENDAR</a></li>
        </ul>
            </div>
        </div>
        <div class="main">
            <div class="content">
                <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../calendar/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../calendar/package-tree.html">Calendar\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
</nav>
                <hr />
<div class="package">Namespace Calendar</div>
<h1>Class CALENDAR</h1>
<div id="list">
    <ul>
        <li><strong>CALENDAR</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>CALENDAR</strong></p>
<div class="comment" id="overview_description">Events Calendar.<br /> This calendar gives a possibility to handle events.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Calendar</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">1.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov &lt;greenray.spb@gmail.com&gt;</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">calendar.class.php</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Overview</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creates calendar with ability to handle events:
 posted news, articles, sports events and so on.
 Requires PHP 5.4</td>
                    </tr>
        </table>
</div>
    <h2 id="details_fields">Fields</h2>
            <div class="location">classes/calendar.class.php at line 21</div>
        <pre class="arguments" id="events">private  array <strong><span class="green">$events</span></strong> = [];</pre>
        <div class="details">Events for specific date</div>
        <hr />
            <div class="location">classes/calendar.class.php at line 24</div>
        <pre class="arguments" id="options">private  array <strong><span class="green">$options</span></strong> = [];</pre>
        <div class="details">Current date</div>
        <hr />
            <div class="location">classes/calendar.class.php at line 27</div>
        <pre class="arguments" id="temp">private  array <strong><span class="green">$temp</span></strong> = [];</pre>
        <div class="details">Auxiliary variable</div>
        <hr />
            <div class="location">classes/calendar.class.php at line 30</div>
        <pre class="arguments" id="today">private  array <strong><span class="green">$today</span></strong> = [];</pre>
        <div class="details">Current date</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">classes/calendar.class.php at line 37</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>(<span class="lilac">array</span> <span class="blue">$options</span>)</code>
    <div class="details">
            <p class="description">Class initialization.</p>
        <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$options</td>
                <td class="hid">Callendar options</td>
                    </tr>
        </table>
</div>
    </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">classes/calendar.class.php at line 47</div>
        <code class="arguments" id="set">public  void <strong>set</strong> (<span class="lilac">integer</span> <span class="blue">$month</span>, <span class="lilac">integer</span> <span class="blue">$year</span>)</code>
        <div class="details">
                    <p class="description">Sets current date.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$month</td>
                <td class="hid">Month</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$year</td>
                <td class="hid">Year</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">classes/calendar.class.php at line 61</div>
        <code class="arguments" id="create">public  array <strong>create</strong> (<span class="lilac">integer</span> <span class="blue">$yearCurrent</span>, <span class="lilac">integer</span> <span class="blue">$yearSelected</span>, <span class="lilac">integer</span> <span class="blue">$monthSelected</span>)</code>
        <div class="details">
                    <p class="description">Creates calendar.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$yearCurrent</td>
                <td class="hid">Current year</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$yearSelected</td>
                <td class="hid">Selected year</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$monthSelected</td>
                <td class="hid">Selected month</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Data for calendar</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">classes/calendar.class.php at line 145</div>
        <code class="arguments" id="event">public  void <strong>event</strong> (<span class="lilac">integer</span> <span class="blue">$day</span>, <span class="lilac">string</span> <span class="blue">$item</span>)</code>
        <div class="details">
                    <p class="description">Assigns event to the calendar.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$day</td>
                <td class="hid">Date</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$item</td>
                <td class="hid">Link to existing post</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">classes/calendar.class.php at line 158</div>
        <code class="arguments" id="highlight">public  void <strong>highlight</strong> (<span class="lilac">integer</span> <span class="blue">$day</span>, <span class="lilac">string</span> <span class="blue">$style</span>)</code>
        <div class="details">
                    <p class="description">Highlights current date.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$day</td>
                <td class="hid">Date</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$style</td>
                <td class="hid">Style for highlighting</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">classes/calendar.class.php at line 169</div>
        <code class="arguments" id="formatTime">public  string <strong>formatTime</strong> (<span class="lilac">string</span> <span class="blue">$format</span>, <span class="lilac">string</span> <span class="blue">$date</span>)</code>
        <div class="details">
                    <p class="description">Formats date and time according to user's timezone.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$format</td>
                <td class="hid">Format</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$date</td>
                <td class="hid">Date</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Formatted date/time</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">classes/calendar.class.php at line 187</div>
        <code class="arguments" id="localiseDate">public  string <strong>localiseDate</strong> (<span class="lilac">string</span> <span class="blue">$string</span>)</code>
        <div class="details">
                    <p class="description">Returns localised date from string generated by date().</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$string</td>
                <td class="hid">Date to localize</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Localized date</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
                    <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../calendar/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../calendar/package-tree.html">Calendar\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
</nav>
            </div>
        </div>
    </div>
    <div class="footer">
        <div class="content">
            <div class="copyright center">Generated by <a href="https://github.com/Greenray/phpAPI" target="_blank">phpAPI</a>: PHP Documentation Creator ver. 6.0 &copy; 2015 - 2016 Greenray</div>
        </div>
    </div>
</body>
</html>
